Skip to main content

FlowDocumentSynchronizer

Provides functionality to synchronize flow documents with configurable options.

Properties

NameDescription
CaptionThe caption dictionary representing localized captions for the flow object.
ValueTypeIndicates the type of the value being synchronized.
TargetDocumentObjectNameThe object name of the target document for synchronization.
FieldsRepresents a list of fields used for mapping between source and target documents.
TargetTableNameThe name of the table in the target document.
ResumeOnErrorIndicates whether the synchronization process should continue when an error occurs. (Deprecated)
TargetQueryNameThe name of the query used for the target document.
KeyA unique identifier for the workflow step.
NameName for the workflow step.
ValueThe actual value being synchronized between source and target.
ErrorDescriptionObjectNameSpecifies the object name for error descriptions during synchronization. (Deprecated)
TargetTypeDefines the type of the target in the synchronization process.
SourceDetailNameThe detail name associated with the source document.
HideSystemFieldsDetermines whether system fields are hidden during synchronization.
SourceTypeDefines the type of the source in the synchronization process.
TargetDetailThe detail associated with the target document.
TargetConnectionNameThe name of the connection for the target document.
SourceDocumentObjectNameThe object name of the source document for synchronization.
WorkflowCodeInstanceThe workflow code instance associated with the flow object.
ErrorOptionsDefines error-related options for the API step.
CachedDMObjectsThe cached document management objects related to the flow object.
TypeCodeThe type code associated with the flow object.
ValueSourceTypeIndicates the source type of the value in the synchronization process.

Constructors

NameDescription
FlowDocumentSynchronizer(name, workflowData, workflowCodeInstance)Constructor for the FlowDocumentSynchronizer class. Initializes a new instance of the FlowDocumentSynchronizer class.
FlowDocumentSynchronizer(name,workflowData,workflowCodeInstance)Initializes a new instance of the FlowDocumentSynchronizer class with a name, workflow data, and workflow code instance.
FlowDocumentSynchronizer(name, workflowData, workflowCodeInstance)Initializes a new instance of the FlowDocumentSynchronizer class.

Methods

NameDescription
Synchronize()Performs the synchronization process between source and target documents.
Initialize()Initializes the flow document synchronizer with the required configurations.

Events

NameDescription
OnAfterExecution(sender, args)Occurs after the execution of the workflow step.
Execute(sender, args)Occurs during the execution of the FlowDocumentSynchronizer step, triggering whenever an execution-related event occurs.
OnBeforeExecution(sender, args)Occurs before the execution of the workflow step.